
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>dispersed_phases.shear_entrainment &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="dispersed_phases.hydrate_formation_time" href="dispersed_phases.hydrate_formation_time.html" />
    <link rel="prev" title="dispersed_phases.load_particle_from_nc_file" href="dispersed_phases.load_particle_from_nc_file.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="dispersed-phases-shear-entrainment">
<h1>dispersed_phases.shear_entrainment<a class="headerlink" href="#dispersed-phases-shear-entrainment" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="dispersed_phases.shear_entrainment">
<code class="sig-prename descclassname">dispersed_phases.</code><code class="sig-name descname">shear_entrainment</code><span class="sig-paren">(</span><em class="sig-param">U</em>, <em class="sig-param">Us</em>, <em class="sig-param">rho</em>, <em class="sig-param">rho_a</em>, <em class="sig-param">b</em>, <em class="sig-param">sin_p</em>, <em class="sig-param">p</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/dispersed_phases.html#shear_entrainment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#dispersed_phases.shear_entrainment" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the entrainment coefficient for shear entrainment</p>
<p>Computes the entrainment coefficient for the shear entrainment for a top
hat model.  This code can be used by both the bent plume model and the 
stratified plume model.  It is based on the concepts for shear entrainment
in Lee and Cheung (1990) and adapted by the model in Jirka (2004).  The
model works for pure jets, pure plumes, and buoyant jets.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>U</strong><span class="classifier">float</span></dt><dd><p>Top hat velocity of entrained plume water (m/s)</p>
</dd>
<dt><strong>Us</strong><span class="classifier">float</span></dt><dd><p>Component of the ambient current projected along the plume 
centerline (m/s)</p>
</dd>
<dt><strong>rho</strong><span class="classifier">float</span></dt><dd><p>Density of the entrained plume fluid (kg/m^3)</p>
</dd>
<dt><strong>rho_a</strong><span class="classifier">float</span></dt><dd><p>Density of the ambient water at the current height (kg/m^3)</p>
</dd>
<dt><strong>sin_p</strong><span class="classifier">float</span></dt><dd><p>Sine of the angle phi from the horizontal with down being positive (up 
is - pi/2)
Cosine of the angle theta from the crossflow direction</p>
</dd>
<dt><strong>p</strong><span class="classifier"><cite>bent_plume_model.ModelParams</cite> or <cite>stratified_plume_model.ModelParams</cite></span></dt><dd><p>Object containing the present model parameters</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>alpha_s</strong><span class="classifier">float</span></dt><dd><p>The shear entrainment coefficient (–)</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/disp_phases.html">Overview of Dispersed Phases Module</a><ul>
      <li>Previous: <a href="dispersed_phases.load_particle_from_nc_file.html" title="previous chapter">dispersed_phases.load_particle_from_nc_file</a></li>
      <li>Next: <a href="dispersed_phases.hydrate_formation_time.html" title="next chapter">dispersed_phases.hydrate_formation_time</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/disp_phases/dispersed_phases.shear_entrainment.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>